MetNoFimex::CDM Class Reference

Data structure of the Common Data Model. More...

#include <CDM.h>

List of all members.

Public Types
typedef std::vector< CDMAttribute >	AttrVec
typedef std::map< std::string, AttrVec >	StrAttrVecMap
typedef std::vector< CDMDimension >	DimVec
typedef std::vector< CDMVariable >	VarVec
Public Member Functions
	CDM ()
virtual	~CDM ()
void	addVariable (const CDMVariable &var) throw (CDMException)
	add variable to cdm
CDMVariable &	getVariable (const std::string &varName) throw (CDMException)
	get a reference of a variable
const CDMVariable &	getVariable (const std::string &varName) const throw (CDMException)
	get a reference of a variable
bool	hasVariable (const std::string &varName) const
	test if variable exists
std::vector< std::string >	findVariables (const std::string &attrName, const std::string &attrValueRegExp) const
	search for variable with certain attribute-value
std::vector< std::string >	findVariables (const std::map< std::string, std::string > &findAttributes, const std::vector< std::string > &findDimensions) const
	search for variable with attribute-values and dimensions
bool	checkVariableAttribute (const std::string &varName, const std::string &attribute, const boost::regex &attrValue) const
void	removeVariable (const std::string &variableName)
	remove a variable and corresponding attributes
void	addDimension (const CDMDimension &dim) throw (CDMException)
	add a dimension to cdm
bool	hasDimension (const std::string &dimName) const
CDMDimension &	getDimension (const std::string &dimName) throw (CDMException)
	get a reference to a dimension
const CDMDimension &	getDimension (const std::string &dimName) const throw (CDMException)
const CDMDimension *	getUnlimitedDim () const
	retrieve the unlimited dimension
bool	hasUnlimitedDim (const CDMVariable &var) const
	test if a variable contains the unlimited dim
void	addAttribute (const std::string &varName, const CDMAttribute &attr) throw (CDMException)
void	addOrReplaceAttribute (const std::string &varName, const CDMAttribute &attr) throw (CDMException)
void	removeAttribute (const std::string &varName, const std::string &attrName)
void	toXMLStream (std::ostream &os) const
	print a xml representation to the stream
const DimVec &	getDimensions () const
	get the dimension
const VarVec &	getVariables () const
	get the variables
const StrAttrVecMap &	getAttributes () const
	get the attributes
std::vector< CDMAttribute >	getAttributes (const std::string &varName) const
	get the attributes of an variable
CDMAttribute &	getAttribute (const std::string &varName, const std::string &attrName) throw (CDMException)
	get an attribute
const CDMAttribute &	getAttribute (const std::string &varName, const std::string &attrName) const throw (CDMException)
	get an const attribute
double	getFillValue (const std::string &varName) const
void	generateProjectionCoordinates (const std::string &projectionVariable, const std::string &xDim, const std::string &yDim, const std::string &lonDim, const std::string &latDim) throw (CDMException)
	generate the projection coordinates (usually named "lat lon")
bool	getProjectionAndAxesUnits (std::string &projectionName, std::string &xAxis, std::string &yAxis, std::string &xAxisUnits, std::string &yAxisUnits) const throw (CDMException)
	extract the names of the projection-variable and the corresponding projection-axes
AttrVec	getProjection (std::string varName) const
	get the projection attributes (as of CF-1.0) of a variable
std::string	getHorizontalXAxis (std::string varName) const
	get the x-(lon) axis of the variable
std::string	getHorizontalYAxis (std::string varName) const
	get the y-(lat) axis of the variable
bool	getLatitudeLongitude (std::string varName, std::string &latitude, std::string &longitude) const
	detect the latitude and longitude coordinates of the variable
std::string	getTimeAxis (std::string varName) const
	get the time axis of the variable
std::string	getVerticalAxis (std::string varName) const
	get the vertical axis of the variable
Static Public Member Functions
static const std::string &	globalAttributeNS ()
	the namespace for global attributes

---

Detailed Description

Data structure of the Common Data Model.

This class implements the data-structure of the Common Data Model version 1 http://www.unidata.ucar.edu/software/netcdf-java/CDM.html

---

Member Typedef Documentation

typedef std::vector<CDMAttribute> MetNoFimex::CDM::AttrVec

typedef std::vector<CDMDimension> MetNoFimex::CDM::DimVec

typedef std::map<std::string, AttrVec> MetNoFimex::CDM::StrAttrVecMap

typedef std::vector<CDMVariable> MetNoFimex::CDM::VarVec

---

Constructor & Destructor Documentation

MetNoFimex::CDM::CDM (   )

virtual MetNoFimex::CDM::~CDM (   )  [virtual]

---

Member Function Documentation

void MetNoFimex::CDM::addAttribute (  const std::string &  varName, const CDMAttribute &  attr )  throw (CDMException)

add an attribute to cdm Parameters: varName  name of the variablt the attribute belongs to attr  the CDMAttribute Exceptions: CDMException  if varName doesn't exist, or attr.getName() already exists

void MetNoFimex::CDM::addDimension (  const CDMDimension &  dim  )  throw (CDMException)

add a dimension to cdm Parameters: dim  the dimension Exceptions: CDMException  if dim-name already exists

void MetNoFimex::CDM::addOrReplaceAttribute (  const std::string &  varName, const CDMAttribute &  attr )  throw (CDMException)

add or replace an attribute of the cdm Parameters: varName  name of variable the attribute belongs to attr  the CDMAttribute Exceptions: CDMException  if vaName doesn't exist

void MetNoFimex::CDM::addVariable (  const CDMVariable &  var  )  throw (CDMException)

add variable to cdm Parameters: var  the variable to add Exceptions: CDMException  if var.varName() already exists

bool MetNoFimex::CDM::checkVariableAttribute (  const std::string &  varName, const std::string &  attribute, const boost::regex &  attrValue )  const

check if a variable contains a attributes with a matching string-value Parameters: varName  variable attribute  the attribute name attrValue  the regexp the string-value of the attribute will match against

std::vector<std::string> MetNoFimex::CDM::findVariables (  const std::map< std::string, std::string > &  findAttributes, const std::vector< std::string > &  findDimensions )  const

search for variable with attribute-values and dimensions And AND search for attributes and dimensions. Parameters: findAttributes  map with (attribute => string-value regExp) pairs findDimensions  vector with dimensions contained in variable Returns: copies of the attributes matching the request

std::vector<std::string> MetNoFimex::CDM::findVariables (  const std::string &  attrName, const std::string &  attrValueRegExp )  const

search for variable with certain attribute-value Parameters: attrName  name of the attribute attrValueRegExp  regular expression the 'string'-value needs to match Returns: copies of the attributes matching the request

void MetNoFimex::CDM::generateProjectionCoordinates (  const std::string &  projectionVariable, const std::string &  xDim, const std::string &  yDim, const std::string &  lonDim, const std::string &  latDim )  throw (CDMException)

generate the projection coordinates (usually named "lat lon") Parameters: projectionVariable  the variable containing the projection information xDim  the x dimension (the corresponding variable needs to contain data and units) yDim  the y dimension (the corresponding variable needs to contain data and units) lonDim  name of the longitude variable latDim  name of the latitude variable Exceptions: CDMException  if any information is missing

const CDMAttribute& MetNoFimex::CDM::getAttribute (  const std::string &  varName, const std::string &  attrName )  const throw (CDMException)

get an const attribute Parameters: varName  name of variable attrName  name of attribute

CDMAttribute& MetNoFimex::CDM::getAttribute (  const std::string &  varName, const std::string &  attrName )  throw (CDMException)

get an attribute Parameters: varName  name of variable attrName  name of attribute

std::vector<CDMAttribute> MetNoFimex::CDM::getAttributes (  const std::string &  varName  )  const

get the attributes of an variable Parameters: varName  name of variable

const StrAttrVecMap& MetNoFimex::CDM::getAttributes (   )  const [inline]

get the attributes Returns: map of type <variableName <attributeName, attribute>>

const CDMDimension& MetNoFimex::CDM::getDimension (  const std::string &  dimName  )  const throw (CDMException)

CDMDimension& MetNoFimex::CDM::getDimension (  const std::string &  dimName  )  throw (CDMException)

get a reference to a dimension Parameters: dimName  name of the dimension Exceptions: CDMException  if dimension doesn't exist

const DimVec& MetNoFimex::CDM::getDimensions (   )  const [inline]

get the dimension

double MetNoFimex::CDM::getFillValue (  const std::string &  varName  )  const

get the fill value of an variable (_FillValue attribute) Returns: value of _FillValue attribute, or MIFI_UNDEFINED_F

std::string MetNoFimex::CDM::getHorizontalXAxis (  std::string  varName  )  const

get the x-(lon) axis of the variable Parameters: varName  name of variable Returns: name of x-axis dimension (or "" if not defined)

std::string MetNoFimex::CDM::getHorizontalYAxis (  std::string  varName  )  const

get the y-(lat) axis of the variable Parameters: varName  name of variable Returns: name of y-axis dimension (or "" if not defined)

bool MetNoFimex::CDM::getLatitudeLongitude (  std::string  varName, std::string &  latitude, std::string &  longitude )  const

detect the latitude and longitude coordinates of the variable Detect the the latitude and longitude coordinates of the variable, this might be one of the dimensions, or a multi-dimensional field of lat(x,y) lon(x,y) variables Parameters: varName  name of variable latitude  return value of the latitude longitude  return value of the longitude Returns: true if latitude and longitude have been found

AttrVec MetNoFimex::CDM::getProjection (  std::string  varName  )  const

get the projection attributes (as of CF-1.0) of a variable Parameters: varName  name of variable Returns: vector of attributes of the projection, an empty vector if no projection found

bool MetNoFimex::CDM::getProjectionAndAxesUnits (  std::string &  projectionName, std::string &  xAxis, std::string &  yAxis, std::string &  xAxisUnits, std::string &  yAxisUnits )  const throw (CDMException)

extract the names of the projection-variable and the corresponding projection-axes Parameters: projectionName  output of the projection variables name xAxis  output of the spatial x axis yAxis  output of the spation y axis xAxisUnit  output of unit for x axis yAxisUnit  output of unit for y axis Returns: true if unique result, false (and print warning) if results are not unique Exceptions: CDMException  if no projection with corresponding axes can be found

std::string MetNoFimex::CDM::getTimeAxis (  std::string  varName  )  const

get the time axis of the variable Parameters: varName  name of variable Returns: name of time dimension (or "" if not defined)

const CDMDimension* MetNoFimex::CDM::getUnlimitedDim (   )  const

retrieve the unlimited dimension Returns: unLimDim pointer with the unlimited dimension, the pointer will be deleted with the CDM

const CDMVariable& MetNoFimex::CDM::getVariable (  const std::string &  varName  )  const throw (CDMException)

get a reference of a variable this is a constant version of CDMVariable::getVariable} Parameters: varName  name of the variable Exceptions: CDMException  if varName doesn't exist

CDMVariable& MetNoFimex::CDM::getVariable (  const std::string &  varName  )  throw (CDMException)

get a reference of a variable Parameters: varName  name of the variable Exceptions: CDMException  if varName doesn't exist

const VarVec& MetNoFimex::CDM::getVariables (   )  const [inline]

get the variables

std::string MetNoFimex::CDM::getVerticalAxis (  std::string  varName  )  const

get the vertical axis of the variable Parameters: varName  name of variable Returns: name of vertical dimension (or "" if not defined)

static const std::string& MetNoFimex::CDM::globalAttributeNS (   )  [inline, static]

the namespace for global attributes

bool MetNoFimex::CDM::hasDimension (  const std::string &  dimName  )  const

check if the dimension exists Parameters: dimName  name of the dimension

bool MetNoFimex::CDM::hasUnlimitedDim (  const CDMVariable &  var  )  const

test if a variable contains the unlimited dim Returns: true/false

bool MetNoFimex::CDM::hasVariable (  const std::string &  varName  )  const

test if variable exists Parameters: varName  name of variable

void MetNoFimex::CDM::removeAttribute (  const std::string &  varName, const std::string &  attrName )

remove an attribute from the cdm Parameters: varName  name of variable the attribute belongs to attr  the CDMAttribute

void MetNoFimex::CDM::removeVariable (  const std::string &  variableName  )

remove a variable and corresponding attributes Parameters: variableName  the variable to remove

void MetNoFimex::CDM::toXMLStream (  std::ostream &  os  )  const

print a xml representation to the stream

---

The documentation for this class was generated from the following file:

• include/fimex/CDM.h

---